<?php

/**
 * Picon Framework
 * http://code.google.com/p/picon-framework/
 *
 * Copyright (C) 2011-2012 Martin Cassidy <martin.cassidy@webquub.com>

 * Picon Framework is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.

 * Picon Framework is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with Picon Framework.  If not, see <http://www.gnu.org/licenses/>.
 * */

namespace picon;

/**
 * Represents the response for a request
 * 
 * Although a request will have only one response, their may be multiple
 * request targets that all write to the response, consiquently it is posible
 * that a page might be rendered twice. It is therefore expected that a page
 * request target will clean the response before it starts to write to it
 * 
 * @author Martin Cassidy
 * @package web/request
 * @todo create helper methods for writing HTTP headers
 */
interface Response
{
    /**
     * @param string $value the value to write to the response
     */
    function write($value);
    
    function flush();
    
    function clean();
    
    function getBody();
    
    function setHeader($value, $status);
}

?>
